
/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.util.Map;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * ISerializer
 *
 * @since 2021-06-02
 */
public interface ISerializer {
    /**
     * deserialize
     *
     * @param reader reader
     * @param clazz clazz
     * @param <T> t
     * @return deserialize data
     */
    <T> @Nullable T deserialize(@NotNull Reader reader, @NotNull Class<T> clazz);

    /**
     * deserialize Envelope
     *
     * @param inputStream inputStream
     * @return SentryEnvelope
     */
    @Nullable
    SentryEnvelope deserializeEnvelope(@NotNull InputStream inputStream);

    /**
     * serialize
     *
     * @param entity entity
     * @param writer writer
     * @param <T> t
     * @throws IOException e
     */
    <T> void serialize(@NotNull T entity, @NotNull Writer writer) throws IOException;

    /**
     * serialize
     *
     * @param envelope envelope
     * @param outputStream outputStream
     * @throws Exception exception
     */
    void serialize(@NotNull SentryEnvelope envelope, @NotNull OutputStream outputStream)
        throws Exception;

    /**
     * serialize
     *
     * @param data data
     * @return serialized data
     * @throws Exception exception
     */
    @NotNull
    String serialize(@NotNull Map<String, Object> data) throws Exception;
}
